﻿// ILKarel.cs
// Copyright 2009 Edgar Said Hernández Sánchez (Limo Wan Kenobi)
// limowankenobi@gmail.com
// http://lnkarel.sourceforge.net/
// http://limotonterias.blogspot.com/

/**
 * This file is part of LNKarel.
 *  
 * LNKarel is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * LNKarel is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LNKarel.  If not, see <http://www.gnu.org/licenses/>.
 **/

using System;
using System.Drawing;

namespace LMSoft.NKarel.Core
{
    public interface ILKarel
    {
        int PosX
        {
            get;
            set;
        }

        /// <summary>
        /// Gets and Sets: Obtiene y asigna la posición en Y (Calle) de Karel en el mundo.
        /// </summary>
        int PosY
        {
            get;
            set;
        }

        /// <summary>
        /// Gets and Sets: Obtiene y asigna la posición (como un <c>Point</c>) de Karel en el Mundo.
        /// </summary>
        Point Pos
        {
            get;
            set;
        }

        /// <summary>
        /// Indica la cantidad de Beepers qe Karel contiene en la mochila.
        /// </summary>
        /// <exception cref="ArgumentException"> si se intenta asignar un valor negativo.</exception>
        int BeepersEnMochila
        {
            get;
            set;
        }

        /// <summary>
        /// Indica hacia donde está viendo Karel.
        /// </summary>
        LkOrientacion Orientacion
        {
            get;
            set;
        }

        /// <summary>
        /// Hace que Karel de un paso en la dirección en la cual está viendo.
        /// </summary>
        /// <remarks>
        /// Dado que Karel no conoce el mundo en el que está, no se hace ninguna validación de que después de ejecutar
        /// el paso, se quede en un estado válido.
        /// </remarks>
        void Paso();

        /// <summary>
        /// Hace que Karel de una vuelta hacia la Izquierda moviendo su orientación.
        /// </summary>
        void VueltaIzquierda();

        /// <summary>
        /// Hace que los beepers en la mochila de beepers de Karel disminuyan en uno.
        /// </summary>
        /// <remarks>
        /// Si no hay beepers no hace nada.
        /// </remarks>
        void DisminuyeBeeper();

        /// <summary>
        /// Hace que los beepers en la mochila de beepers de Karel aumenten en uno.
        /// </summary>
        void AumentaBeepers();

    }
}
